|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.doclinx.ftxml.CatalogItem
This class represents a Catalog information block or entry.
Each catalog entry corresponds to a single document.
A document is typically contained in one file; however, composite files
or archives (for example a .zip file) may contain multiple
documents. This object is returned by the CatalogManager.catGetEntry
method.
CatalogManager
Field Summary | |
com.doclinx.ftxml.FileTime |
access
Date file was last accessed created. |
int |
attrs
Attributes of this entry. |
com.doclinx.ftxml.FileTime |
creation
Date file was created. |
long |
fileLength
If composite file, then total number of bytes starting at offset. |
long |
fileOffset
If composite file, then byte offset in file of component. |
int |
fileType
The file type detected by the parser. |
java.lang.String |
sAuxInfo
Extra information returned from the processing of the file. |
java.lang.String |
sFileName
File name of document. |
java.lang.String |
sUrlInfo
If using a mapfile from a webcrawl, then this field contains the URL where the file originated. |
com.doclinx.ftxml.FileTime |
write
Date file was last modified. |
Constructor Summary | |
CatalogItem()
|
Method Summary | |
boolean |
getAttr(int attr)
Checks the passed in bit fields and return true if
any of the bits in the attr parameter correspond the the attrs field. |
void |
loadFromBytes(byte[] data)
|
byte[] |
toBytes()
|
java.lang.StringBuffer |
toHtml(int position)
Returns an HTML representation of this CatalogItem object. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public java.lang.String sFileName
public int attrs
IS_FILTER1
.
Some bit values are API input settings, others are generated.
The values indicate information about how the entry was created,
if it's a composite or archive component, or if marked for deletion.
public com.doclinx.ftxml.FileTime creation
public com.doclinx.ftxml.FileTime access
public com.doclinx.ftxml.FileTime write
ADD_MODE_MODIFIED
mode
in the catAddFile
method.
FileTime
public java.lang.String sUrlInfo
catLastEntryStringUpdateURL
method when adding files one at a time. This URL data is not
used by the catalog manager.
public int fileType
public long fileOffset
public long fileLength
public java.lang.String sAuxInfo
Format: "TITLE\nABSTRACT\nENCODING\nALT TITLE\nADDITIONAL TEXT\nPARMS" Note: TITLE and ABSTRACT are returned if the tag XML containing containing this information is set with theSeecatSetXMLSemantics
method. ALT TITLE is a user supplied title and may be indexed if thesr_indexAltTitle
parameter is used. ADDITIONAL TEXT is never indexed. ENCODING is the value of the HTML charset or XML encoding attribute. PARMS are any user defined parameter values for the file.
sr_altTitle
parse
parameter for more information.
Constructor Detail |
public CatalogItem()
Method Detail |
public java.lang.StringBuffer toHtml(int position)
position
- The entry number of the Catalog Item
**none
- **public boolean getAttr(int attr)
true
if
any of the bits in the attr parameter correspond the the attrs field.
attr
- Bits to check against the attrs field
true
if both attr and attrs have bits set in same position.
**none**
SRC2STF_PARMS.IS_FILTER1
public byte[] toBytes()
public void loadFromBytes(byte[] data)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |